De l’intérêt du format Markdown pour rédiger et organiser ses notes de travail

Bibliopea1

Pierre Musitelli

2023-12-01

La limite des logiciels traditionnels de traitement de texte

J’ai longtemps utilisé Microsoft Word pour tous mes travaux de recherche — notes, esquisses, brouillons et manuscrits —, ainsi que des logiciels de type bloc-notes, comme TextEdit, pour consigner au vol des idées, des listes. Mes documents, enregistrés dans des formats disparates (.doc, .docx, .odt, .rtf,.txt, sans compter les fichiers plus anciens dépourvus d’extension), étaient glissés dans des dossiers chronologiques ou thématiques, par cours, par œuvre ou auteur, par colloque, par programme de concours à préparer, par appel à projet, pêle-mêle avec des documents PDF.

Un exemple d’arborescence de dossiers et fichiers divers. Notez qu’un dossier et un sous-dossier portent le même titre, que les informations sont mal hiérarchisées, que les titres en disent trop ou pas assez…

Impossible, en travaillant ainsi, de mutualiser des fiches entre plusieurs projets, sauf à les dupliquer ou à les déplacer d’un dossier vers un autre. Et en cas de doublon, difficile de se souvenir de la version de travail la plus utile à conserver. C’est une collection de fragments dans laquelle on navigue à vue.
Difficile aussi, vu la disparité des formats, d’utiliser efficacement la fonction “rechercher” pour retrouver un terme ou localiser un document précis au sein de cet ensemble — sauf bien sûr à utiliser l’outil de recherche du système d’exploitation, souvent imparfait et peu apte à hiérarchiser les résultats.

Composer, centraliser, organiser, interroger une collection de fichiers textes

En 2018, j’ai opté pour Scrivener, élégant logiciel de traitement de texte édité par Literature and Latte. Il est payant mais son prix reste modique (les membres de la communauté éducative et universitaire peuvent acquérir une licence à 60€ et l’installation est permise sur plusieurs postes).

Scrivener

Un “projet” Scrivener est un classeur de fichiers .rtf, accessibles par arborescence dans un explorateur de documents, situé dans le volet gauche de la fenêtre de visualisation et d’édition des textes. Cette fenêtre peut être scindée pour afficher simultanément différents documents ou plusieurs fois le même texte. Un document long peut être constitué d’une pluralité de notes autonomes (chacune constituant un chapitre, une partie ou sous-partie, par exemple), dont l’ordre peut être permuté dans l’arborescence. On peut aussi enregistrer des pages web, des images, etc.

L’application est souple d’utilisation et son fonctionnement est assez intuitif. Elle offre une solution intéressante pour la rédaction de textes longs dans un format enrichi, et permet la sauvegarde des versions successives d’un même document. Chaque projet, avec la collection de documents qu’il comporte, est encapsulé dans un format .scriv propriétaire.

Fin 2021, j’ai décidé d’adopter le format Markdown et de me servir principalement d’Obsidian, un logiciel qui m’a conduit à repenser ma façon de prendre des notes et de les organiser.

Obsidian

Fondé en 2020 et développé par une équipe de taille modeste, Obsidian est un éditeur et gestionnaire de textes au format Markdown. Il est présenté par ses créateurs comme une application de gestion des connaissances personnelles (PKM en anglais, pour Personal Knowledge Management), c’est-à-dire un logiciel qui aide à réunir, organiser et présenter des informations, comme il en existe aujourd’hui une multitude (Notion, Roam, Evernote, Tana, etc.).

Il a joui d’une rapide notoriété en ligne, réunissant une communauté d’utilisateurs et de contributeurs très actifs notamment en matière de création d’extensions (ou “modules”), qui ajoutent des fonctionnalités au logiciel. J’en évoquerai quelques-unes dans ce carnet.
Il faut souligner qu’Obsidian n’est pas open source. Cependant, il est gratuit pour un usage personnel, il est multiplateforme et repose sur l’usage du format Markdown qui, lui, est open source. Tous les documents créés peuvent donc être ouverts et modifiés par n’importe quel logiciel capable de lire du texte brut.

Les avantages du format Markdown

Une compatibilité large et rétroactive

Markdown, qui a été créé au début des années 2000 par John Gruber et Aaron Swartz, est un langage de balisage léger. Il utilise une syntaxe simple, facile à composer avec un éditeur de texte et facile à lire même dans son apparence non formatée.

Disposer d’archives textuelles au format Markdown (dont l’extension est .md) présente l’avantage considérable de garantir un accès pérenne aux données enregistrées. Des éditeurs de texte brut tels que TextEdit (sous macOS), Notepad ou Notepad++ (sous Windows) sont capables de lire et d’éditer un fichier Markdown. Même le logiciel Vim, créé en 1988, peut le faire.

Tout fichier .md peut être ouvert, lu et modifié par n’importe quel logiciel capable de manipuler du texte brut. Ici un fichier .md ouvert avec TextEdit, éditeur de fichier .txt sous macOS.

L’avantage du format Markdown, outre son interopérabilité, c’est sa simplicité. Pas de feuilles de style, pas de mise en forme typographique avancée : du texte brut, dans des fichiers de quelques octets ou kilo-octets. Ma base de données, qui contient plus de 1600 fichiers .md, ne dépasse pas 11 Mo. Cela permet de disposer d’archives légères et d’accélérer les temps de sauvegarde ou de synchronisation des données en ligne, par exemple.

Une syntaxe simple

Dans le format Markdown, la mise en forme d’un texte est relativement sommaire et les principes de la syntaxe sont très faciles à assimiler. Je propose dans l’article qui suit une description complète du formatage d’un texte. Je m’en tiendrai ici à une présentation des grands principes.

Le texte est justifié à gauche. On ne choisit ni la fonte, ni la couleur. La taille des caractères est unique.
Le texte peut être mis en gras, en italique, barré ou surligné au moyen de balises :

**gras** (placer deux astérisques au début et à la fin du mot ou groupe de mots)

_italique_ (un tiret bas au début et à la fin du mot).

~~barré~~ (deux tildes au début et à la fin du passage à barrer)

==surlignement== (deux signes “égal” au début et à la fin du passage à surligner).

Les balises se combinent.

Pour appliquer un style, on a trois options :

Un document Markdown peut être structuré en sections (jusqu’à 6 niveaux de titre imbriqués). Le plan du document actif apparaît dans le volet latéral d’Obsidian. Il permet d’accéder directement aux différentes sections du texte et d’en permuter l’ordre si nécessaire.

La syntaxe Markdown permet aussi de créer des blocs de citation en retrait en utilisant un chevron fermant en début de paragraphe (>). Par exemple, le paragraphe suivant :

Helvétius écrit :

> Il n’est point d’**éducation** sans objet ; et l’unique qu’on puisse se proposer, c’est, comme je l’ai déjà dit, de rendre les citoyens plus forts, plus éclairés, plus vertueux, et enfin plus propres à contribuer au bonheur de la société dans laquelle ils vivent. Or, dans les gouvernements arbitraires, l’opposition que les despotes croient apercevoir entre leur intérêt et l’intérêt général, ne leur permet pas d’adopter un système si conforme à l’utilité publique. Dans ces pays, il n’est donc point d’objet d’éducation, ni par conséquent d’éducation. (_De l’Esprit_, 1758)

produit ce résultat :

On peut aussi insérer des encadrés de différentes couleurs pour mettre en évidence certains passages de notre texte (“callouts”), et bien sûr insérer des notes de fin de document, auxquelles renvoient des appels de note cliquables, comme dans une page Wikipedia.

Des documents reliés les uns aux autres

Les fichiers Markdown peuvent être reliés les uns aux autres par des liens hypertextes. C’est une ressource extraordinaire pour organiser une collection de notes dans le cadre d’un projet de recherche au long cours, comme nous le verrons.

Enfin, chaque fichier peut être doté d’un en-tête YAML (“YAML frontmatter”) comportant les métadonnées telles que titre, auteur, date, mots-clés, personnes citées, etc. ce qui facilite considérablement l’indexation des contenus et l’interrogation de la bibliothèque de documents. J’évoque ce point dans un autre article.

Exemple d’en-tête YAML destiné à recevoir les métadonnées, classées par variables.

Obsidian, un éditeur de texte et une bibliothèque de documents

Une interface modulable

Fiches de lecture, notes pour des projets, organisation de la recherche, planning de travail et to-do-lists, préparation de cours ou rédaction d’articles… Obsidian est devenu, du fait de sa polyvalence et de la possibilité d’en configurer finement l’usage, mon principal outil de travail. Même s’il reste difficile de se passer de logiciels tels que Word pour la recherche en sciences humaines dans la mesure où la plupart des revues et des maisons d’édition demandent que les manuscrits leur soient remis au format .doc ou .docx, Obsidian ou tout logiciel comparable permet de s’en passer jusqu’à la phase de finalisation des documents et de se libérer, lors de la composition des textes, de toute préoccupation typographique pour se concentrer sur le contenu.

L’ensemble des documents créés ou importés dans ce logiciel sont disposés au sein d’un répertoire qui fait office de bibliothèque de documents (appelée “vault”, ou “coffre”). Il s’agit en fait d’un simple dossier, dont l’accès est libre et dont on choisit le nom et l’emplacement sur le disque dur. Tous les fichiers .md y sont regroupés (ainsi que les fichiers cachés utilisés par Obsidian et ses modules pour fonctionner, et les éventuelles pièces jointes aux documents).
Les notes peuvent être déposées en vrac dans le dossier racine ou classées par thèmes et projets dans une arborescence de dossiers. Dans l’interface d’Obsidian, comme dans celle de Zettlr (voir plus bas), on accède aux fichiers par le biais d’un explorateur de documents situé dans le volet de gauche. Mais on peut, à tout moment, accéder à l’ensemble de ces dossiers et fichiers via le navigateur de notre système d’exploitation, comme à n’importe quel autre dossier ou fichier enregistré sur notre disque dur.

À gauche, l’arborescence d’un modèle de répertoire de travail dans le Finder de macOS / À droite, cette même arborescence dans l’éditeur Obsidian

La fenêtre de l’éditeur peut afficher plusieurs fichiers simultanément, en vis-à-vis ou dans des onglets à la manière d’un navigateur internet. L’interface est souple, les menus dans les volets de droite et de gauche ainsi que les onglets sont ajustables par glisser-déposer. Tout s’ouvre et se ferme instantément.

Dans Obsidian, les onglets peuvent s’ouvrir en arrière-plan, s’« empiler » verticalement, et se déplacer par glisser-déposer tout en s’ajustant automatiquement en fonction de leur positionnement dans la fenêtre de l’éditeur.

L’un des avantages de ce logiciel, c’est qu’il propose une pré-visualisation du texte mis en forme. Les marqueurs du langage Markdown s’estompent dès que le curseur quitte le segment en cours d’écriture, ce qui assure un certain confort de lecture et peut faciliter la transition depuis un logiciel de traitement de texte simulant une page imprimée, comme Word.

Plusieurs modes de visualisation

Pour être plus précis, Obsidian dispose de trois modes de visualisation des contenus :

Tout d’abord le mode édition, activé par défaut. Il n’affiche les marqueurs Markdown (astérisques, étoiles, crochets…) qu’autour des mots ou groupes de mots que l’on est en train de saisir au clavier ou sur lesquels on place le curseur. Ces marqueurs disparaissent dès que l’on passe au reste de la phrase. Seul s’affiche alors le texte mis en forme.

Dans ce mode de visualisation, le texte est cependant ‘mobile’ au sens où une phrase comportant des marqueurs s’allonge lorsque ces derniers deviennent visibles, et rétrécit dès qu’ils sont masqués.

Le mode source laisse les marqueurs apparents en permanence, mais permet de prévisualiser leur effet sur la mise en forme du texte. Et le mode lecture masque les marqueurs et ne permet pas de modifier le texte.

L’interface d’Obsidian offre la possibilité, comme le montre cette capture d’écran, de travailler en mode source (fenêtre de gauche) pour intervenir sur le texte sans être gêné par les effets d’occultation/affichage des marqueurs ; et de visualiser dans la fenêtre de gauche le texte mis en forme sans les marqueurs.

Enregistrement en continu et récupération de fichier

Notez que le logiciel enregistre vos fichiers en continu et qu’il dispose d’une précieuse option “Récupération de fichier” (dans le menu “Modules principaux”) permettant de parcourir et restaurer les versions antérieures de vos textes. Cette fonction peut être paramétrée dans les paramètres d’Obsidian.

Une bibliothèque de “modules complémentaires” (extensions) développés et mis à jour par une communauté active de passionnés offre des possibilités de configuration avancée très intéressantes : modification de la police de caractères par défaut, ajustement de la couleur des titres, des stylage, des blocs de citations), assistant pour l’importation de documents, exportation vers d’autres formats, intégration de logiciels tiers comme Zotero, ajout d’un calendrier, automatisation de certaines tâches… Par ailleurs, le logiciel s’enrichit régulièrement de fonctionnalités nouvelles, comme les marques-pages ou encore une gestion facilitée des métadonnées (“propriétés”) et des tableaux. J’évoque dans les articles de ce carnet un certain nombre de ces extensions.

Un répertoire de fichiers librement accessibles et librement modifiables

Je le disais, Obsidian est l’un des nombreux gestionnaires de notes au format Markdown. Concrètement, cela signifie que plusieurs logiciels sont en mesure d’ouvrir une bibliothèque de fichiers Markdown créés sous Obsidian, de naviguer dans l’arborescence des documents, de visualiser, modifier et réorganiser la structure et le contenu des dossiers et des textes. Zettlr, Sublime Text, voire Logseq, pour ne citer que des logiciels gratuits, open source et multiplateformes, s’acquittent très bien de cette tâche.
Comme le format des fichiers est open source, leur contenu ne se trouvera en aucun cas affecté, ni modifié, ni converti par le simple fait de les ouvrir avec un autre logiciel. Cela garantit un accès pérenne à votre base de travail, non tributaire d’un logiciel ni d’un système d’exploitation donné. Cela permet même d’utiliser conjointement, comme je le fais, Obsidian et Zettlr.

C’est le principe du “file over app” : les logiciels pouvant être frappés d’obsolescence, il est essentiel que les utilisateurs gardent au moins la maîtrise des fichiers qu’ils utilisent. Un document Markdown, qui ne perd rien de son intégrité même quand il est lu comme texte brut, offre des bien gages quant à l’accès aux données qu’il contient et à leur archivage.

Zettlr, une solution complémentaire

Certains ont une préférence pour le logiciel Zettlr, plus spécifiquement destiné à un public universitaire et pour la recherche. Il a été développé par le Suédois Hendrik Erz, docteur en sociologie. Contrairement à Obsidian, il est open source.
Sa simplicité est un atout et quelques unes de ses fonctionnalités leur rendent particulièrement intéressant et complémentaire d’Obsidian :

En revanche, l’interface de Zettlr est moins aboutie que celle d’Obsidian, les fonctionnalités proposées sont moindres, du fait aussi de l’absence de modules complémentaires, et l’application ne dispose pas d’application pour smartphone et tablette.

Cela dit, tout l’intérêt du format Markdown, c’est que chacun est libre de juger sur pièce des avantages et des limites des différents éditeurs disponibles et reste toujours libre passer de l’un à l’autre selon ses besoins occasionnels, tout en conservant sa base de travail et sans modifier fondamentalement ses pratiques d’écriture. Pour ma part, je fais un usage régulier de Zettlr pour palier certains défauts d’Obsidian.

Il ne s’agit donc pas de faire le choix de l’un contre l’autre, mais de profiter de l’un et de l’autre. Cette cohabitation se déroule d’ailleurs sans accroc. La preuve, c’est qu’il est possible d’ouvrir simultanément le même document .md dans Obsidian et dans Zettlr. Les modifications du texte dans l’un seront immédiatement affichées dans l’autre.

Dans le GIF ci-dessus, on voit à gauche un fichier .md ouvert dans Obsidian et à droite le même fichier ouvert dans Zettlr. La modification apportée au titre est répercutée de droite à gauche sans conflit de version ni de logiciel.

De nombreux tutoriels en ligne

Pour se familiariser avec Zettlr et ses fonctionnalités, on peut consulter :

Quant à Obsidian, une simple recherche en ligne permet de constater le nombre impressionnant de blogs, forums et chaînes youtube – notamment en anglais – qui lui sont consacrés. Pour un usage universitaire ou adapté à la recherche dans le domaine des Humanités, on peut consulter la page For Academics, qui répertorie plusieurs blogs en anglais dédiés notamment à la question de l’interaction entre Obsidian et Zotero. Parmi ces pages, je recommande Doing History with Zotero and Obsidian, qui offre des suggestions de configuration pour tirer le meilleur parti de l’intégration de Zotero dans Obsidian – un point auquel je consacre par ailleurs un article assez détaillé. On trouvera aussi des indications utiles dans ce long tutoriel “Obsidian Tutorial for Academic Writing” (inscription gratuite requise).

De nombreuses chaînes youtube explorent toutes les facettes et les fonctionnalités d’Obsidian et de ses extensions. Citons :

Citer ce billet
Pierre Musitelli (2023, 1er décembre). De l’intérêt du format Markdown pour rédiger et organiser ses notes de travail. Bibliopea. Consulté le 5 mars 2024, à l’adresse https://bibliopea.hypotheses.org/58